Create SIG Docs charter #3001

zacharysarah · 2018-12-01T00:03:23Z

Add a SIG Docs charter

This PR adds a charter for SIG Docs as specified by kubernetes/steering#31.

No lazy consensus

Because this PR involves creation of a SIG charter, all SIG Docs co-chairs must actively review and approve this PR.

/sig docs
/assign @bgrant0607
/cc @jaredbhatti @Bradamant3

spiffxp · 2018-12-02T23:10:03Z

/committee steering

chenopis · 2018-12-05T23:56:10Z

Should we mention Release Notes?
Otherwise...
/LGTM

spiffxp

Some clarifying questions

sig-docs/charter.md

spiffxp · 2018-12-05T23:58:23Z

/hold
for a few questions and one other SC reviewer

Bradamant3 · 2018-12-06T00:00:00Z

I'd like to see us flesh out at least a few more things, along the lines of:

descriptions of current working groups (tools, Andrew and Dominik's k8s modeling work)
addition of something that reflects content work we plan for 2019 (because atm the charter reads like we're a group of editors and tool junkies, and we do more than that)
agree with @chenopis on mention of release notes
(more?) discussion of face-to-face summits, planning and organizing

pwittrock · 2018-12-06T21:54:02Z

/assign pwittrock

pwittrock · 2018-12-06T21:55:18Z

sig-docs/charter.md

+
+SIG Docs is responsible for Kubernetes documentation.
+
+The responsibility for feature documentation lies with feature developers. SIG Docs sets standards for feature documentation, provides clear paths for docs contribution, and coordinates documentation updates during quarterly releases.


What is SIG docs relationship with Kubernetes components outside of kubernetes/kubernetes? What about other subprojects?

What is SIG docs relationship with Kubernetes components outside of kubernetes/kubernetes? What about other subprojects?

We may advise subprojects or other components outside of k/k; however, we are not responsible for documentation outside of the k/website repo.

Can we update the charter to say that specifically. E.g. sig-docs is responsible for the documentation on the kubernetes website and for components living in kubernetes/kubernetes. sig-docs may be responsible for components living outside kubernetes/kubernetes if it is important to have the documentation on the k8s.io website. sig-docs may consult on documentation for components outside k/k that exists outside of k8s.io, but is not obligated to.

@pwittrock 👋 I have several questions about this statement:

sig-docs may be responsible for components living outside kubernetes/kubernetes if it is important to have the documentation on the k8s.io website.

Who decides what is important?
What does "responsible" mean in this context?
Are there specific examples of products outside of k/k that need documentation on k8s.io?
How does SIG Docs discover when a product needs docs to live on k8s.io?

There's a lot of unknowns there, many of which seem to obscure responsibility rather than clarify it. I recommend replacing this line with:

SIG Docs is sometimes advises on Kubernetes components outside of the Kubernetes/Kubernetes GitHub repository, or on other Kubernetes subprojects, but is not responsible for the documentation of any of these components or projects.

pwittrock · 2018-12-06T21:57:27Z

sig-docs/charter.md

+
+SIG Docs is responsible for Kubernetes documentation.
+
+The responsibility for feature documentation lies with feature developers. SIG Docs sets standards for feature documentation, provides clear paths for docs contribution, and coordinates documentation updates during quarterly releases.


Consider adding an explicit list of the types of documentation owned by SIG docs - Documentation for the core Kubernetes APIs, for cli tools that are shipped with the Kubernetes release, etc... e.g. SIG docs doesn't own go-doc documentation for libraries, or the sample-controller example repo.

We should mention generation of reference documentation as well.

I've added the specificity you recommen, @pwittrock. I'd love further review!

sig-docs/charter.md

chenopis · 2018-12-07T00:41:22Z

@Bradamant3 Since this is just a charter, I don't think we need to get into specifics of which working groups exist, etc., just that we may form working groups to tackle specific areas of concern or projects. You can give examples like the Tooling & Infra working group or the Modeling working group, but I wouldn't give the impression that we are offering a comprehensive list.

chenopis

There are a couple unaddressed comments. Specifically:

[line 49] Primary documentation of new features
[line 69] SIG Chairs

sig-docs/charter.md

Bradamant3 · 2018-12-07T20:43:02Z

Thanks @chenopis for the very specific clarification!

Bradamant3 · 2018-12-07T22:08:33Z

To the steering committee/governance review folks: @chenopis @zacharysarah and I have all worked on this PR and are in agreement about its contents. If either of them pushes a commit on top of mine, I'm fine with it. Hope it helps review and merge (not sure when I'll be able to check again so this note is to make sure I don't hold up the approval process).

chenopis

/lgtm

zacharysarah · 2019-01-28T19:28:51Z

@pwittrock 👋 I'm finally back from vacation; I'll reach out after getting current with this PR.

spiffxp · 2019-01-28T21:56:46Z

cla/linuxfoundation — commit missing GitHub user

More CLA fun!

I'm guessing this is because @Bradamant3 now works for VMware instead of Heptio, and she probably changed e-mail addresses in her GitHub profile.

These commits will need to be redone with an e-mail address that belongs to a GitHub user that has signed the CLA

pwittrock · 2019-02-05T18:41:33Z

@zacharysarah

Welcome Back! Sounds good. If I don't hear from you I will check back every week or so.

pwittrock · 2019-02-05T18:45:18Z

Also should have pinged @Bradamant3

zacharysarah · 2019-02-11T20:40:01Z

I'm working on this PR this week, my goal is to finish revisions by Thursday EOD.

k8s-ci-robot · 2019-02-14T00:42:36Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Bradamant3, chenopis, zacharysarah

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~sig-docs/OWNERS~~ [Bradamant3,chenopis,zacharysarah]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

zacharysarah · 2019-02-14T00:44:57Z

@spiffxp I rebased to resolve the CLA issue. 👍

zacharysarah · 2019-02-14T00:46:55Z

/cc @jaredbhatti since he's replacing @chenopis as co-chair

zacharysarah · 2019-02-14T18:47:03Z

/assign @jaredbhatti

pwittrock · 2019-02-20T02:46:53Z

/lgtm

Will let @jaredbhatti remove the hold.

sig-docs/charter.md

first round of revisions based on comments more edits/revisions per more comments respond to comments Feedback from spiffxp and pwittrock Feedback from pwittrock, part 2 Feedback from pwittrock, round 3 Feedback from jaredbhatti

jaredbhatti · 2019-02-26T01:46:01Z

/lgtm
/hold cancel

k8s-ci-robot assigned bgrant0607 Dec 1, 2018

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Dec 1, 2018

k8s-ci-robot requested review from Bradamant3 and chenopis December 1, 2018 00:03

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Dec 1, 2018

k8s-ci-robot added the committee/steering Denotes an issue or PR intended to be handled by the steering committee. label Dec 2, 2018

k8s-ci-robot assigned chenopis Dec 5, 2018

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 5, 2018

spiffxp reviewed Dec 5, 2018

View reviewed changes

sig-docs/charter.md Show resolved Hide resolved

sig-docs/charter.md Outdated Show resolved Hide resolved

sig-docs/charter.md Outdated Show resolved Hide resolved

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 5, 2018

jdumars mentioned this pull request Dec 6, 2018

Charters Meta-issue kubernetes/steering#31

Closed

k8s-ci-robot assigned pwittrock Dec 6, 2018

pwittrock reviewed Dec 6, 2018

View reviewed changes

sig-docs/charter.md Outdated Show resolved Hide resolved

pwittrock reviewed Dec 6, 2018

View reviewed changes

sig-docs/charter.md Outdated Show resolved Hide resolved

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 7, 2018

chenopis suggested changes Dec 7, 2018

View reviewed changes

sig-docs/charter.md Outdated Show resolved Hide resolved

sig-docs/charter.md Outdated Show resolved Hide resolved

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 7, 2018

chenopis approved these changes Dec 7, 2018

View reviewed changes

Bradamant3 approved these changes Dec 10, 2018

View reviewed changes

This was referenced Jan 28, 2019

Open source CLAbot cncf/foundation#3

Closed

Update the cla plugin to allow overriding the CLA check kubernetes/test-infra#11004

Closed

zacharysarah force-pushed the new-sig-docs-charter branch from 3f7f134 to 6b3081d Compare February 14, 2019 00:42

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 14, 2019

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 14, 2019

zacharysarah force-pushed the new-sig-docs-charter branch from 6b3081d to 19ea304 Compare February 14, 2019 00:43

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Feb 14, 2019

k8s-ci-robot assigned jaredbhatti Feb 14, 2019

zacharysarah force-pushed the new-sig-docs-charter branch 2 times, most recently from bd4e753 to 8227bce Compare February 19, 2019 21:30

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 20, 2019

jaredbhatti suggested changes Feb 20, 2019

View reviewed changes

Create SIG Docs charter

af8e4bf

first round of revisions based on comments more edits/revisions per more comments respond to comments Feedback from spiffxp and pwittrock Feedback from pwittrock, part 2 Feedback from pwittrock, round 3 Feedback from jaredbhatti

zacharysarah force-pushed the new-sig-docs-charter branch from 8227bce to af8e4bf Compare February 25, 2019 23:25

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 25, 2019

k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. and removed do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels Feb 26, 2019

k8s-ci-robot merged commit 2826f1d into kubernetes:master Feb 26, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create SIG Docs charter #3001

Create SIG Docs charter #3001

zacharysarah commented Dec 1, 2018 •

edited

Loading

spiffxp commented Dec 2, 2018

chenopis commented Dec 5, 2018

spiffxp left a comment

spiffxp commented Dec 5, 2018

Bradamant3 commented Dec 6, 2018

pwittrock commented Dec 6, 2018

pwittrock Dec 6, 2018

chenopis Dec 7, 2018

pwittrock Jan 15, 2019

zacharysarah Feb 14, 2019

pwittrock Dec 6, 2018

chenopis Dec 7, 2018

pwittrock Jan 15, 2019

zacharysarah Feb 14, 2019

chenopis commented Dec 7, 2018 •

edited

Loading

chenopis left a comment

Bradamant3 commented Dec 7, 2018

Bradamant3 commented Dec 7, 2018

chenopis left a comment

zacharysarah commented Jan 28, 2019

spiffxp commented Jan 28, 2019 •

edited

Loading

pwittrock commented Feb 5, 2019

pwittrock commented Feb 5, 2019

zacharysarah commented Feb 11, 2019

k8s-ci-robot commented Feb 14, 2019

zacharysarah commented Feb 14, 2019

zacharysarah commented Feb 14, 2019

zacharysarah commented Feb 14, 2019

pwittrock commented Feb 20, 2019

jaredbhatti commented Feb 26, 2019


		SIG Docs is responsible for Kubernetes documentation.

		The responsibility for feature documentation lies with feature developers. SIG Docs sets standards for feature documentation, provides clear paths for docs contribution, and coordinates documentation updates during quarterly releases.

Create SIG Docs charter #3001

Create SIG Docs charter #3001

Conversation

zacharysarah commented Dec 1, 2018 • edited Loading

Add a SIG Docs charter

No lazy consensus

spiffxp commented Dec 2, 2018

chenopis commented Dec 5, 2018

spiffxp left a comment

Choose a reason for hiding this comment

spiffxp commented Dec 5, 2018

Bradamant3 commented Dec 6, 2018

pwittrock commented Dec 6, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chenopis commented Dec 7, 2018 • edited Loading

chenopis left a comment

Choose a reason for hiding this comment

Bradamant3 commented Dec 7, 2018

Bradamant3 commented Dec 7, 2018

chenopis left a comment

Choose a reason for hiding this comment

zacharysarah commented Jan 28, 2019

spiffxp commented Jan 28, 2019 • edited Loading

pwittrock commented Feb 5, 2019

pwittrock commented Feb 5, 2019

zacharysarah commented Feb 11, 2019

k8s-ci-robot commented Feb 14, 2019

zacharysarah commented Feb 14, 2019

zacharysarah commented Feb 14, 2019

zacharysarah commented Feb 14, 2019

pwittrock commented Feb 20, 2019

jaredbhatti commented Feb 26, 2019

zacharysarah commented Dec 1, 2018 •

edited

Loading

chenopis commented Dec 7, 2018 •

edited

Loading

spiffxp commented Jan 28, 2019 •

edited

Loading